name: pre-commit run_id: commands[2] env HOME: /home/jenkins env LANG: C.UTF-8 env OLM_TIMER1: 3000 env OLM_TIMER2: 2000 env PATH: /w/workspace/transportpce-tox-verify-transportpce-master/.tox/pre-commit/bin:/opt/pyenv/bin:/tmp/venv-TQma/bin:/opt/pyenv/shims:/home/jenkins/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/opt/puppetlabs/bin env PIP_DISABLE_PIP_VERSION_CHECK: 1 env PIP_USER: 0 env PYTHONHASHSEED: 2276790684 env PYTHONIOENCODING: utf-8 env SSH_AUTH_SOCK: ******************************** env TOX_ENV_DIR: /w/workspace/transportpce-tox-verify-transportpce-master/.tox/pre-commit env TOX_ENV_NAME: pre-commit env TOX_WORK_DIR: /w/workspace/transportpce-tox-verify-transportpce-master/.tox env VIRTUAL_ENV: /w/workspace/transportpce-tox-verify-transportpce-master/.tox/pre-commit env __TOX_ENVIRONMENT_VARIABLE_ORIGINAL_CI: true metadata pid: 2576 cwd: /w/workspace/transportpce-tox-verify-transportpce-master/tests allow: /w/workspace/transportpce-tox-verify-transportpce-master/.tox/pre-commit/bin/*:sh:cpan:sudo:which:fixCIcentOS8reposMirrors.sh cmd: pre-commit run --all-files --show-diff-on-failure exit_code: 1 [INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks. [INFO] Initializing environment for https://github.com/jorisroovers/gitlint. [INFO] Initializing environment for https://github.com/jorisroovers/gitlint:./gitlint-core[trusted-deps]. [INFO] Initializing environment for https://github.com/Lucas-C/pre-commit-hooks. [INFO] Initializing environment for https://github.com/pre-commit/mirrors-autopep8. [INFO] Initializing environment for https://github.com/perltidy/perltidy. [INFO] Initializing environment for https://github.com/koalaman/shellcheck-precommit. [INFO] Initializing environment for https://github.com/pre-commit/mirrors-prettier. [INFO] Initializing environment for https://github.com/pre-commit/mirrors-prettier:prettier@4.0.0-alpha.8. [INFO] Initializing environment for https://github.com/adrienverge/yamllint. [INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/Lucas-C/pre-commit-hooks. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/pre-commit/mirrors-autopep8. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/perltidy/perltidy. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/pre-commit/mirrors-prettier. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/adrienverge/yamllint. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... trim trailing whitespace.................................................Failed - hook id: trailing-whitespace - exit code: 1 - files were modified by this hook Fixing docs/developer-guide.rst fix end of files.........................................................Passed check for added large files..............................................Passed check for merge conflicts................................................Passed check for case conflicts.................................................Passed check json...............................................................Passed mixed line ending........................................................Passed Tabs remover.............................................................Passed autopep8.................................................................Passed perltidy.................................................................Passed ShellCheck v0.10.0.......................................................Passed prettier.................................................................Failed - hook id: prettier - files were modified by this hook tapi/docs/Notifications.md servicehandler/docs/Notifications.md yamllint.................................................................Passed pre-commit hook(s) made changes. If you are seeing this message in CI, reproduce locally with: `pre-commit run --all-files`. To run `pre-commit` as part of git workflow, use `pre-commit install`. All changes made by hooks: diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 5c586bd54..10e9c7294 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -431,8 +431,8 @@ TapiNetworkNotificationHandler ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Listens to the general `Notification` -* if notificationType is `NOTIFICATIONTYPEATTRIBUTEVALUECHANGE` and targetObjectType is `TOPOLOGYOBJECTTYPENODEEDGEPOINT` - then it updates the connections and the connectivity services with regards to the changes. It then sends an +* if notificationType is `NOTIFICATIONTYPEATTRIBUTEVALUECHANGE` and targetObjectType is `TOPOLOGYOBJECTTYPENODEEDGEPOINT` + then it updates the connections and the connectivity services with regards to the changes. It then sends an `NbiNotification`for each connectivityService updated. `Overview `_ @@ -454,7 +454,7 @@ For a `cancel-resource-result` this applies: * If the result is failed, then it logs this as info. * If the result is pending, then it logs this as a warning. * If the result is unknown, then it logs an error -* If the result is successful, then it deletes the connections and connectivity associated with the servicename +* If the result is successful, then it deletes the connections and connectivity associated with the servicename in the result. `Overview `_ diff --git a/servicehandler/docs/Notifications.md b/servicehandler/docs/Notifications.md index 78357d265..7db9dc30f 100644 --- a/servicehandler/docs/Notifications.md +++ b/servicehandler/docs/Notifications.md @@ -5,41 +5,43 @@ and their current use. #### NetworkModelNotificationHandler -* Listens to `TopologyUpdateResult` from the `NetworkModel`module. -* Only outputs logs of the notification statuses. +- Listens to `TopologyUpdateResult` from the `NetworkModel`module. +- Only outputs logs of the notification statuses. #### PceNotificationHandler -* Listens to `ServicePathRpcResult` from `transportpce.pce.rev240205`. -* if this result is a successful `PathComputationResult`, then it will create a new service and service path. -* if this result is a failed or unknown `PatchComputationResult`, then it will forward this as a NbiNotification. -* if this result is a sucessful `CancelResourceResult`, then it will delete the service fetched from the notification. -* It will send `NbiNotifications` about the status of the deletion. +- Listens to `ServicePathRpcResult` from `transportpce.pce.rev240205`. +- if this result is a successful `PathComputationResult`, then it will create a new service and service path. +- if this result is a failed or unknown `PatchComputationResult`, then it will forward this as a NbiNotification. +- if this result is a sucessful `CancelResourceResult`, then it will delete the service fetched from the notification. +- It will send `NbiNotifications` about the status of the deletion. #### RendererNotificationHandler -* Listens to `RendererRpcResultSp` from the `Renderer`module. +- Listens to `RendererRpcResultSp` from the `Renderer`module. For `service-implementation-request` this applies. -* if the request is successful , then it tries to start the service. The result is forwarded as an `NbiNotification` -* if the request is failed, then it forward this as a `NbiNotification`. -* if the request is pending or unknown (default) then it logs this result as warning + +- if the request is successful , then it tries to start the service. The result is forwarded as an `NbiNotification` +- if the request is failed, then it forward this as a `NbiNotification`. +- if the request is pending or unknown (default) then it logs this result as warning For `service-delete` this applies: -* if the request is successful It tries to delete the service name from the otn-topology. -* if the request is pending it logs this as warning -* if the request failed it forwards this as an `NbiNotification` -* if the request unknown status (default), it logs this as an error. + +- if the request is successful It tries to delete the service name from the otn-topology. +- if the request is pending it logs this as warning +- if the request failed it forwards this as an `NbiNotification` +- if the request unknown status (default), it logs this as an error. #### ServiceListener -* Listens to `DataTreeChanged` -* if `DELETE` it do nothing -* if `DELETE` is combined with a service name that is beeing rerouted it will try to create a new service with the -service name from the notification. This is actually rerouting step 2. -* if `WRITE` with a node that is taken out of service it forwards this as an NbiNotification. -Further if the `adminstrativeState` is `inService`, and there still exist a valid path, it will try to reroute the service -by adding it to the rerouting services and then delete the service. This will trigger a new `DataTreeChanged` -notification that will start rerouting step 2 above. -* if `WRITE` with a node that is taken into service, and the `administrativeState` is `ìnService` then it -forwards this as an `NbiNotification`. +- Listens to `DataTreeChanged` +- if `DELETE` it do nothing +- if `DELETE` is combined with a service name that is beeing rerouted it will try to create a new service with the + service name from the notification. This is actually rerouting step 2. +- if `WRITE` with a node that is taken out of service it forwards this as an NbiNotification. + Further if the `adminstrativeState` is `inService`, and there still exist a valid path, it will try to reroute the service + by adding it to the rerouting services and then delete the service. This will trigger a new `DataTreeChanged` + notification that will start rerouting step 2 above. +- if `WRITE` with a node that is taken into service, and the `administrativeState` is `ìnService` then it + forwards this as an `NbiNotification`. diff --git a/tapi/docs/Notifications.md b/tapi/docs/Notifications.md index 9c90c7fa0..4b1097863 100644 --- a/tapi/docs/Notifications.md +++ b/tapi/docs/Notifications.md @@ -5,40 +5,42 @@ and their current use. #### TapiNetworkNotificationHandler -* Listens to the general `Notification` -* if notificationType is `NOTIFICATIONTYPEATTRIBUTEVALUECHANGE` and targetObjectType is `TOPOLOGYOBJECTTYPENODEEDGEPOINT` -then it updates the connections and the connectivity services with regards to the changes. It then send an -* `NbiNotification`for each connectivityService updated. +- Listens to the general `Notification` +- if notificationType is `NOTIFICATIONTYPEATTRIBUTEVALUECHANGE` and targetObjectType is `TOPOLOGYOBJECTTYPENODEEDGEPOINT` + then it updates the connections and the connectivity services with regards to the changes. It then send an +- `NbiNotification`for each connectivityService updated. #### TapiPceNotificationHandler -* Listens to `ServicePathRpcresult` from the `pce` module. +- Listens to `ServicePathRpcresult` from the `pce` module. For a `path-computation-result` this applies: -* if this result is a successful , then it creates connections from the `ServicePathResult` -and stores it in the database. -* if this result is pending, it will log a warning -* if this result is failed, or unkown (default) then it will log an error. + +- if this result is a successful , then it creates connections from the `ServicePathResult` + and stores it in the database. +- if this result is pending, it will log a warning +- if this result is failed, or unkown (default) then it will log an error. For a `cancel-resource-result` this applies: -* If the result is failed, then it logs this as info. -* If the result is pending, then it logs this as a warning. -* If the result is unknown, then it logs an error -* If the result is successful, then it deletes the connections and connectivity associated with the servicename -in the result. + +- If the result is failed, then it logs this as info. +- If the result is pending, then it logs this as a warning. +- If the result is unknown, then it logs an error +- If the result is successful, then it deletes the connections and connectivity associated with the servicename + in the result. #### TapiRendererNotificationHandler -* Listens to `RendererRpcResultSp` from the `renderer`module. +- Listens to `RendererRpcResultSp` from the `renderer`module. For a result of type `service-implementation-request` this applies: -* If status is pending or unknown (default) it will log this as a warning. -* If status is failed it will delete the associated connections and connectivity of the associated service. -* If status is successful it will update the connections and connectivity of the associated service, -and it will also send an `NbiNotification` that the service has been published to TAPI. +- If status is pending or unknown (default) it will log this as a warning. +- If status is failed it will delete the associated connections and connectivity of the associated service. +- If status is successful it will update the connections and connectivity of the associated service, + and it will also send an `NbiNotification` that the service has been published to TAPI. #### TapiServiceNotificationHandler -* Listens to `ServiceRpcResultSh` from the `servicehandler`module. -* Whenever triggered it will log an error message "Avoid dataBroker error " and the name of the databroker. +- Listens to `ServiceRpcResultSh` from the `servicehandler`module. +- Whenever triggered it will log an error message "Avoid dataBroker error " and the name of the databroker.